package com.coderush.admin.core.component;

import org.springframework.stereotype.Component;

/**
 * 雪花算法(Snowflake) ID生成器工具类
 *
 * <p>Snowflake是Twitter开源的分布式ID生成算法，结果是一个long型的ID。
 * 其核心思想是：使用41bit作为毫秒数，10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID），
 * 12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生4096个ID），最后还有一个符号位，永远是0。</p>
 *
 * <p>
 *     线程安全：使用synchronized保证多线程环境下的正确性
 *     可读性强：详细的注释和清晰的代码结构
 *     工具方法友好：提供了ID解析、格式化等实用方法
 *     可配置：支持通过配置文件设置workerId和datacenterId
 *     异常处理：处理了时钟回拨等异常情况
 * </p>
 *
 * <p>
 *     注意事项
 *          需要确保各节点的workerId和datacenterId组合唯一
 *          如果系统时钟回拨，会抛出异常
 *          默认起始时间为2020-01-01，可根据需要调整twepoch
 * </p>
 *
 * <p>结构如下(每部分用-分开):
 * 0 - 0000000000 0000000000 0000000000 0000000000 0 - 00000 - 00000 - 000000000000
 * </p>
 */
@Component
public class SnowflakeIdGenerator {

    // ==============================Fields===========================================
    /** 开始时间截 (2020-01-01) */
    private final long twepoch = 1577808000000L;

    /** 机器id所占的位数 */
    private final long workerIdBits = 5L;

    /** 数据标识id所占的位数 */
    private final long datacenterIdBits = 5L;

    /** 支持的最大机器id，结果是31 (这个移位算法可以很快的计算出几位二进制数所能表示的最大十进制数) */
    private final long maxWorkerId = -1L ^ (-1L << workerIdBits);

    /** 支持的最大数据标识id，结果是31 */
    private final long maxDatacenterId = -1L ^ (-1L << datacenterIdBits);

    /** 序列在id中占的位数 */
    private final long sequenceBits = 12L;

    /** 机器ID向左移12位 */
    private final long workerIdShift = sequenceBits;

    /** 数据标识id向左移17位(12+5) */
    private final long datacenterIdShift = sequenceBits + workerIdBits;

    /** 时间截向左移22位(5+5+12) */
    private final long timestampLeftShift = sequenceBits + workerIdBits + datacenterIdBits;

    /** 生成序列的掩码，这里为4095 (0b111111111111=0xfff=4095) */
    private final long sequenceMask = -1L ^ (-1L << sequenceBits);

    /** 工作机器ID(0~31) */
    private long workerId;

    /** 数据中心ID(0~31) */
    private long datacenterId;

    /** 毫秒内序列(0~4095) */
    private long sequence = 0L;

    /** 上次生成ID的时间截 */
    private long lastTimestamp = -1L;

    // ==============================Constructors=====================================
    /**
     * 构造函数
     * @param workerId 工作ID (0~31)
     * @param datacenterId 数据中心ID (0~31)
     */
    public SnowflakeIdGenerator(long workerId, long datacenterId) {
        if (workerId > maxWorkerId || workerId < 0) {
            throw new IllegalArgumentException(String.format("worker Id can't be greater than %d or less than 0", maxWorkerId));
        }
        if (datacenterId > maxDatacenterId || datacenterId < 0) {
            throw new IllegalArgumentException(String.format("datacenter Id can't be greater than %d or less than 0", maxDatacenterId));
        }
        this.workerId = workerId;
        this.datacenterId = datacenterId;
    }

    // ==============================Methods==========================================
    /**
     * 获得下一个ID (该方法是线程安全的)
     * @return SnowflakeId
     */
    public synchronized long nextId() {
        long timestamp = timeGen();

        //如果当前时间小于上一次ID生成的时间戳，说明系统时钟回退过这个时候应当抛出异常
        if (timestamp < lastTimestamp) {
            throw new RuntimeException(
                    String.format("Clock moved backwards. Refusing to generate id for %d milliseconds", lastTimestamp - timestamp));
        }

        //如果是同一时间生成的，则进行毫秒内序列
        if (lastTimestamp == timestamp) {
            sequence = (sequence + 1) & sequenceMask;
            //毫秒内序列溢出
            if (sequence == 0) {
                //阻塞到下一个毫秒,获得新的时间戳
                timestamp = tilNextMillis(lastTimestamp);
            }
        }
        //时间戳改变，毫秒内序列重置
        else {
            sequence = 0L;
        }

        //上次生成ID的时间截
        lastTimestamp = timestamp;

        //移位并通过或运算拼到一起组成64位的ID
        return ((timestamp - twepoch) << timestampLeftShift) //
                | (datacenterId << datacenterIdShift) //
                | (workerId << workerIdShift) //
                | sequence;
    }

    /**
     * 阻塞到下一个毫秒，直到获得新的时间戳
     * @param lastTimestamp 上次生成ID的时间截
     * @return 当前时间戳
     */
    protected long tilNextMillis(long lastTimestamp) {
        long timestamp = timeGen();
        while (timestamp <= lastTimestamp) {
            timestamp = timeGen();
        }
        return timestamp;
    }

    /**
     * 返回以毫秒为单位的当前时间
     * @return 当前时间(毫秒)
     */
    protected long timeGen() {
        return System.currentTimeMillis();
    }

    // ==============================Utils Methods====================================
    /**
     * 从Snowflake ID中解析出时间戳(创建时间)
     * @param snowflakeId snowflake id
     * @return 时间戳
     */
    public long extractTimestamp(long snowflakeId) {
        return (snowflakeId >> timestampLeftShift) + twepoch;
    }

    /**
     * 从Snowflake ID中解析出数据中心ID
     * @param snowflakeId snowflake id
     * @return 数据中心ID
     */
    public long extractDatacenterId(long snowflakeId) {
        return (snowflakeId >> datacenterIdShift) & maxDatacenterId;
    }

    /**
     * 从Snowflake ID中解析出工作机器ID
     * @param snowflakeId snowflake id
     * @return 工作机器ID
     */
    public long extractWorkerId(long snowflakeId) {
        return (snowflakeId >> workerIdShift) & maxWorkerId;
    }

    /**
     * 从Snowflake ID中解析出序列号
     * @param snowflakeId snowflake id
     * @return 序列号
     */
    public long extractSequence(long snowflakeId) {
        return snowflakeId & sequenceMask;
    }

    /**
     * 格式化Snowflake ID为字符串表示形式
     * @param snowflakeId snowflake id
     * @return 格式化后的字符串
     */
    public String format(long snowflakeId) {
        return String.format("%d-%d-%d-%d",
                extractTimestamp(snowflakeId),
                extractDatacenterId(snowflakeId),
                extractWorkerId(snowflakeId),
                extractSequence(snowflakeId));
    }
}